| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

CompilationResult.h
1 // CompilationResult.h
3 //
5
6 namespace nkScripts
7 {
11 enum class COMPILATION_FAILURE_TYPE
12 {
13 NO_ERROR = 0,
14 UNKNOWN,
15 INTERPRETER_UNKNOWN,
16 SYNTAX,
17 MEMORY_ALLOCATION
18 } ;
19
23 struct CompilationResult final
24 {
25 nkMemory::String _failureMessage ;
26
27 COMPILATION_FAILURE_TYPE _failureType = COMPILATION_FAILURE_TYPE::NO_ERROR ;
28
29 bool _success = true ;
30 } ;
31 }
32
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkScripts::COMPILATION_FAILURE_TYPE::INTERPRETER_UNKNOWN
@ INTERPRETER_UNKNOWN
The interpreter for the script is unknown.
nkScripts::COMPILATION_FAILURE_TYPE::UNKNOWN
@ UNKNOWN
An unknown error.
nkScripts::CompilationResult::_success
bool _success
If the loading was a success (true) or not (false).
Definition: CompilationResult.h:29
nkScripts::CompilationResult
Holds information about script loading attempt.
Definition: CompilationResult.h:24
nkMemory::String
Class holding information about a string, with ownership over the data.
Definition: String.h:22
nkScripts::COMPILATION_FAILURE_TYPE::NO_ERROR
@ NO_ERROR
No error, compilation went fine.
nkScripts::COMPILATION_FAILURE_TYPE::MEMORY_ALLOCATION
@ MEMORY_ALLOCATION
Could not allocate memory when needed.
nkScripts::COMPILATION_FAILURE_TYPE::SYNTAX
@ SYNTAX
Syntax parsing error in sources.
nkScripts::CompilationResult::_failureMessage
nkMemory::String _failureMessage
The failure description, if any.
Definition: CompilationResult.h:25
nkScripts::COMPILATION_FAILURE_TYPE
COMPILATION_FAILURE_TYPE
Describes compilation failure types.
Definition: CompilationResult.h:12
nkScripts::CompilationResult::_failureType
COMPILATION_FAILURE_TYPE _failureType
The failure type, if any.
Definition: CompilationResult.h:27